home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / utility / mendes11.zip / DESIGN.DOC next >
Text File  |  1993-11-19  |  23KB  |  519 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                THE MENU DESIGNER
  11.                              Shareware Version 1.1
  12.  
  13.  
  14.  
  15.  
  16.                  Software Copyright (c) 1993 by Chad Attermann
  17.                                  and Tony Kemp
  18.                               ALL RIGHTS RESERVED
  19.  
  20.  
  21.  
  22.                         Archive filename: MENDES11.ZIP
  23.  
  24.  
  25.  
  26.  
  27. DISCLAIMER
  28.  
  29.      The authors of this program, Chad B. Attermann and Tony Kemp, shall not 
  30.      be held responsible for any damages, loss of data or any other loss as a 
  31.      result of using this software. The user, by using this software, takes 
  32.      FULL responsibility and liability for use of and any damages, losses, 
  33.      etc... as a result of this software. Every effort has been made to ensure 
  34.      that this software is free from defects and has been thoroughly tested 
  35.      before release to the general public.
  36.  
  37.  
  38. REGISTRATION
  39.  
  40.      This program is Shareware. Feel free to distribute the program (in it's
  41.      unaltered form and archive) as Shareware. You are free to use this program
  42.      for a period of forty-five (45) days. Thus, you are able to try the
  43.      software for a forty-five (45) day evaluation period to see if it meets
  44.      your needs. If you use the Menu Designer after the forty-five (45) day
  45.      evaluation period, you are asked to send the author $15.00 to register the
  46.      software (Menu Designer + Display Module).
  47.  
  48.      The registered version will not contain the [ UNREGISTERED ] trademark in
  49.      the menu desktop header. Furthermore, the registered version will support
  50.      a mouse in the Menu Designer Display Module, and the package will include
  51.      some utilities to enhance your batch files.
  52.  
  53.  
  54.  
  55. TABLE OF CONTENTS
  56.  
  57.      In this documentation, there are sections on the various stages of the
  58.      Menu Designer which supplement the on-line help when creating your menus.
  59.      Following is a table of contents:
  60.  
  61.  
  62.  
  63.           Introduction.....................................  1
  64.           Installing the Menu Designer ....................  2
  65.           General Directions ..............................  3
  66.           Menu Options ....................................  4
  67.           Colors ..........................................  5
  68.           Size and Position ...............................  6
  69.           Making Entries ..................................  7
  70.           Using the environment utilities .................  8
  71.           Using the directory utilities ................... 10
  72.  
  73.  
  74.  
  75. Menu Designer version 1.1                                               Page 1
  76.  
  77.  
  78. INTRODUCTION
  79.  
  80.      Welcome to the Menu Designer! This menu system was created in an effort to
  81.      make stylized menus without all the hassle, memory and compatibility
  82.      problems, while still giving you an attractive menu that performs as well
  83.      as other commercial ones on the market. It saves you time, precious
  84.      memory, and it's EASY TO USE!
  85.  
  86.      * (Registered Version only)
  87.      You should have the following files:
  88.  
  89.           DESIGN.DOC             This document
  90.           MENU.DOC               Documentation on the Menu Display Module
  91.           LICENSE.DOC            The license agreement--IMPORTANT!
  92.           DESIGN.EXE             The Menu Designer
  93.           MENU.EXE               The Menu Designer Display Module
  94.           ENVIRON.EXE            Environment Variable Transfer Utility
  95.           ENVIRGET.EXE           Environment Variable Update Utility (store)
  96.           ENVIRSET.EXE           Environment Variable Update Utility (retrieve)
  97.           DIRGET.EXE             Directory Restore Utility (store)
  98.           DIRSET.EXE             Directory Restore Utility (retrieve)
  99.           DESIGN.HLP             On-line help file for the Menu Designer
  100.           MENU.HLP               On-line help file for the Menu Display Module
  101.           MENU.DFT               Default options file
  102.           RUNMENU.BAT            A batch file to run menus
  103.           EXAMPLE.BAT            An example menu
  104.  
  105.      These should all be contained in the file:  MENUDSGN.ZIP
  106.  
  107.      * (Shareware Version only)
  108.      You should have the following files:
  109.  
  110.           DESIGN.DOC             This document
  111.           MENU.DOC               Documentation on the Menu Display Module
  112.           LICENSE.DOC            The license agreement--IMPORTANT!
  113.           DESIGN.EXE             The Menu Designer
  114.           MENU.EXE               The Menu Designer Display Module
  115.           DESIGN.HLP             On-line help file for the Menu Designer
  116.           MENU.HLP               On-line help file for the Menu Display Module
  117.           MENU.DFT               Default options file
  118.           RUNMENU.BAT            A batch file to run menus
  119.           FILE_ID.DIZ            Small note on the Designer
  120.           ORDER.FRM              Order form to order the Designer
  121.  
  122.      These should all be contained in the file:  MENDES11.ZIP
  123.  
  124.  
  125.  
  126. Menu Designer version 1.1                                               Page 2
  127.  
  128.  
  129. GENERAL INSTALLATION
  130.  
  131.      1.   Make one backup copy of the program disk, and then use the backup
  132.           copy to install the programs to your hard drive. Keep the backup disk
  133.           and original disks in a safe place. If your computer does not have a
  134.           hard drive, use the backup disk for regular use.
  135.  
  136.      2.   Copy the file MENUDSGN.ZIP from your backup disk to the directory you
  137.           want the program and menu files to reside. All menus you make must
  138.           remain in the same directory with the executable files. This is
  139.           required for for proper operation of the Display Module.
  140.           (*Note:  Shareware version file is MENDES11.ZIP)
  141.  
  142.      3.   Use the decompression program PKUNZIP v204g or higher to decompress
  143.           the file into the programs mentioned above. (This program is not
  144.           included.)
  145.     
  146.      4.   The DOS environment variable MENU must be set to the complete path of
  147.           the directory in which you installed the Menu Designer. This variable
  148.           must be set in order for the Menu Designer and Display Module to
  149.           execute. Follow the installation specifics corresponding to your
  150.           setup below.
  151.  
  152.  
  153. NETWORK INSTALLATION SPECIFICS
  154. (Be sure to follow the general installation guidelines before continuing)
  155.  
  156.      The most efficient method for setting the DOS variable MENU is using the
  157.      Netware global login script, or equivalent in other network environments.
  158.      The Netware command will look similar to the following:
  159.  
  160.           DOS SET MENU="F:\MENUDSGN\"
  161.  
  162.      If users have disimilar drive mappings, then it may be necessary to set
  163.      the variable from within the user's personal login script, or through a
  164.      DOS batch file. A batch command will look similar to the following:
  165.  
  166.           SET MENU=F:\MENUDSGN\
  167.  
  168.  
  169. STANDALONE PC INSTALLATION SPECIFICS
  170. (Be sure to follow the general installation guidelines before continuing)
  171.     
  172.      The most effective method for setting the DOS variable MENU on a
  173.      standalone PC is to include it in your AUTOEXEC.BAT file. The batch
  174.      command will look similar to the following:
  175.  
  176.           SET MENU=C:\MENUDSGN\
  177.  
  178.  
  179.  
  180. Menu Designer version 1.1                                               Page 3
  181.  
  182.  
  183. GENERAL DIRECTIONS
  184.  
  185.      The general way to use the Menu Designer is quite easy. To begin a menu,
  186.      from DOS type DESIGN and then press the ENTER key. Next, you will need to
  187.      give the menu a name. The designer will create a file using this name, and
  188.      this batch file is your menu. You can also type DESIGN, followed by the
  189.      name of the file you wish to create or edit (without the .BAT extension)
  190.      on the command line.
  191.  
  192.      Examples:
  193.  
  194.           F:\MENUDSGN>DESIGN
  195.                or
  196.           F:\MENUDSGN>DESIGN MENU1     
  197.  
  198.      Here are the keys that used to make and edit the menus.
  199.  
  200.      1.   Use the ARROW keys to navigate through the entries in the menu.
  201.  
  202.      2.   Press the INSERT key to insert a new entry above the one that is
  203.           currently highlighted.
  204.  
  205.      3.   Press the DELETE key to delete the entry that is currently
  206.           highlighted.
  207.  
  208.      4.   Press ENTER to edit the entry that is currently highlighted.
  209.  
  210.      5.   Press the F1 function key for the on-line help facility.
  211.  
  212.      6.   Press the F2 function key to run the Options Editor. With the Options
  213.           Editor, you can change the menu title, subtitle, footer, external
  214.           screen saver, time in minutes until a screen saver is activated, and
  215.           fill character options.
  216.  
  217.      7.   Press the F3 function key to run the Colors Editor. With the Colors
  218.           Editor, you can change the foreground and background colors of the
  219.           menu window, highlight bar, desktop, and footer.
  220.  
  221.      8.   Press the F4 function key to run the Size and Position Editor. With
  222.           the Size and Position editor, you can change the width, length,
  223.           horizontal position, and vertical position of separate menus.
  224.  
  225.  
  226.  
  227. Menu Designer version 1.1                                               Page 4
  228.  
  229.  
  230. OPTIONS EDITOR
  231.  
  232.      When you begin to create a menu, you will be prompted for the menu TITLE,
  233.      and SUBTITLE. Type in the title of your choice for the menu you are
  234.      creating. The menu TITLE will appear in the header of the menu, and is
  235.      required for all menus.
  236.  
  237.      The menu SUBTITLE, will appear directly below the title in the header. If
  238.      you do not want a subtitle, you can leave this option blank. The FOOTER
  239.      will appear in the bottom right corner of the desktop. The footer for the
  240.      main menu will override the footers for any submenus. Leave this option
  241.      blank if you choose not to display a footer in your menu.
  242.  
  243.      The EXTERNAL SCREEN SAVER is the name of any screen saver program that you
  244.      want to execute after the specified number of minutes. Because there are
  245.      no means for specifying command line parameters at this time, the screen
  246.      saver must have a default setting. If you don't have another screen saver
  247.      or just don't want to use one, leave this option blank to use the built in
  248.      screen blanker. Your screen will go black after the specified time, and
  249.      pressing any key brings your menu back.
  250.  
  251.      The MINUTES option specifies how long the menu stands idle before it
  252.      becomes a screen saver or executes your external screen saver. This number
  253.      must be from 1 to 255.
  254.  
  255.      The DESKTOP FILL CHARACTER is the decimal code for the character that you
  256.      ould like to fill the desktop with. You can choose the character you
  257.      wantfrom the ASCII table found in the online help under the options
  258.      editor.
  259.  
  260.  
  261.  
  262. Menu Designer version 1.1                                               Page 5
  263.  
  264.  
  265. COLORS EDITOR
  266.  
  267.      To use the color editor, use the ARROW keys to select the combination that
  268.      you want to edit, then press ENTER.
  269.  
  270.      Use the UP/DOWN ARROWS to change the foreground color.
  271.  
  272.      Use the LEFT/RIGHT ARROWS to change the background color.
  273.  
  274.      Press ENTER or ESC to select a new combination to edit. Press ESC again to
  275.      exit the Colors Editor. You will then be prompted to either accept the
  276.      changes or cancel them.
  277.  
  278.      The MENU WINDOW is the menu itself. The foreground color is the color of
  279.      the border, normal entries, prompts in the status bar at the bottom of the
  280.      desktop, and the clock in the header box in the upper right corner of the
  281.      desktop. The background color is the background of the menu, the status
  282.      bar, and the header box.
  283.  
  284.      The HIGHLIGHT BAR is the color of the currently selected entry. The
  285.      foreground color is the color of the entry name. The background color is
  286.      the color of the bar surrounding the name.
  287.  
  288.      The DESKTOP is the color of the underlying screen. The foreground color is
  289.      the color of the fill character. The background color is the color
  290.      surrounding the fill character.
  291.  
  292.      The FOOTER is the foreground color of the footer in bottom right corner of
  293.      the status bar.
  294.  
  295.  
  296.  
  297. Menu Designer version 1.1                                               Page 6
  298.  
  299.  
  300. SIZE AND POSITION EDITOR
  301.  
  302.      To use the size and position editor, press F4 and the menu options will
  303.      temporarily disappear. You can then move the menu anywhere on the desktop
  304.      except for the header area in the upper right corner of the desktop.
  305.  
  306.      Use the ARROW keys alone to move the menu around on the desktop.
  307.  
  308.      Hold down the CTRL key while pressing the ARROW keys to resize the menu.
  309.  
  310.      Hold down a SHIFT key while pressing the ARROW keys for justification.
  311.      This will justify the menu all the way up, down, left, or right, depending
  312.      on which arrow key you use.
  313.  
  314.      Pressing the PAGEDOWN key will center the menu horizontally, and pressing
  315.      the PAGEUP key will center the menu vertically.
  316.  
  317. * Hint:   When centering the menu, center it horizontally first, then
  318.           vertically. This will keep the upper left title box from interfering.
  319.  
  320.  
  321.  
  322. Menu Designer version 1.1                                               Page 7
  323.  
  324.  
  325. ENTRY EDITOR
  326.  
  327.      When making entries, use the ARROW keys or TAB/SHIFT TAB to navigate
  328.      through the Entry Editor.
  329.  
  330.      The NAME is what will actually appear on the menu. This should be a
  331.      descriptive title pertaining to the function of that entry. You must
  332.      supply a name.
  333.  
  334.      The COMMAND is what DOS uses to invoke the program or command. Separate
  335.      commands can be specified if they are separated by a semicolon (;). The
  336.      names of submenus can be entered without any extension, because the
  337.      extension .BAT is assumed. In the case of menus named after users, the
  338.      full username can be specified, even if it exceeds 8 characters.
  339.      Environment variables can also be used to make dynamic submenus by using
  340.      the DOS %variable% convention. When calling batch files in the command
  341.      ine, be sure to include the .BAT extension. This is necessary for proper
  342.      functioning of the batch files.
  343.  
  344.      * Note -  When specifying a submenu on the command line, it must be the
  345.                first command, you may only specify one submenu on the command
  346.                line, and you must check the SUBMENU check box.
  347.  
  348.      The DIRECTORY is the DOS directory that you want to run the commands from.
  349.      This directory will be switched to before the program is executed. This
  350.      line can be left blank provided that you have a network search mapping, or
  351.      DOS PATH statement set to the directory in which you installed the Menu
  352.      Designer.
  353.  
  354.      Check Boxes:   Press the SPACE bar or the "X" key to toggle the check
  355.                     marks on and off.
  356.  
  357.      The SUBMENU check box should be checked if the command is a submenu call.
  358.      This takes care of appending the necessary parameters in the menu file.
  359.  
  360.      The RETURN check box should be checked if you would like to return to the
  361.      menu after executing the command. Leave this box unchecked if you are
  362.      making an "Exit" or other such entry. The program will return you to the
  363.      DOS prompt after execution.
  364.  
  365.  
  366.  
  367. Menu Designer version 1.1                                               Page 8
  368.  
  369. USING THE ENVIRONMENT UTILITIES
  370. (* Registered Version only)
  371.  
  372.      The files ENVIRON.EXE, ENVIRGET.EXE, and ENVIRSET.EXE have been included
  373.      with this package for your own use. They effectively transfer and/or
  374.      update the environment variables from one instance to another. Following
  375.      is a detailed desription of each and it's function.
  376.  
  377.  
  378. ENVIRGET/ENVIRSET UTILITY
  379. (* Registered Version only)
  380.  
  381.      The files ENVIRGET.EXE and ENVIRSET.EXE are to be used together to update
  382.      your original environment instance after running and modifying a new one.
  383.      To do this, follow the steps below.
  384.    
  385.      1.   Run ENVIRGET while still in the original environment. The program
  386.           accepts a command line that specifies which directory to use when
  387.           writing to disk. You can either specify an actual drive and
  388.           directory, or use the DOS convention of %variable% , where variable
  389.           is a DOS environment variable containing a valid directory path, such
  390.           as the MENU variable used in the Menu Designer. A data file named
  391.           ENVIRON.DAT will be created in the directory that you specify, or the
  392.           current one if none is specified. You do not need to concern yourself
  393.           with this file. It will be deleted when it is no longer needed.
  394.  
  395.      2.   Run ENVIRSET from the new environment, after you have finished using
  396.           the environment. Be sure to specify the same directory or variable on
  397.           the command line as you did for ENVIRGET, or that you are in the same
  398.           directory if you excluded the directory command line parameter. A
  399.           batch file named ENVIRON.BAT will be created in the directory, which
  400.           you will use to update the original environment in the next step.
  401.  
  402.      3.   Run the batch file ENVIRON.BAT once you have exited the new
  403.           environment, and returned to the original one. This will set or
  404.           remove the necessary variables in the original environment. You can
  405.           delete this file after running it if you wish.
  406.  
  407.      The original environment is now updated with the changes made to the
  408.      previous environment. Once again, remember to include the same directory
  409.      on the command line of both programs, or run them from the same directory
  410.      if not including a path on the command line. Following is a sample batch
  411.      file to demonstrate the process:
  412.     
  413.                                      ┌───  (RUN.BAT)
  414.           %MENU%ENVIRGET.EXE %MENU%  │ │    SET PRINTER=DOT
  415.           COMMAND.COM /C RUN.BAT ────┘ │    SET PROMPT=
  416.           CALL %MENU%ENVIRON.BAT       │    %MENU%ENVIRSET.EXE %MENU%
  417.  
  418.  
  419.  
  420. Menu Designer version 1.1                                               Page 9
  421.  
  422.  
  423. ENVIRON UTILITY
  424. (* Registered Version only)
  425.  
  426.      The utility ENVIRON.EXE is similar to ENVIRGET/ENVIRSET, with a few
  427.      exceptions. ENVIRON is easier to use, but instead of updating the original
  428.      environment with changes made to the previous environment, it simply
  429.      copies the new environment to the original one. The only major thing this
  430.      effects is that any variables that were present in the original
  431.      environment, but removed in the new environment, will NOT be removed from
  432.      the original environment upon returning to it. This will not present a
  433.      problem in most cases, so ENVIRON would be the better choice in those
  434.      cases. One advantage of ENVIRON is if a copy of your original environment
  435.      is not past to the new one, then using ENVIRON would be a better choice,
  436.      because ENVIRGET/ENVIRSET would remove any variables in the original
  437.      environment that were not passed to the new one. Following are the steps
  438.      for using ENVIRON.
  439.  
  440.      1.   Run ENVIRON from the new environment, AFTER you have finished using
  441.           the environment. The program accepts a command line that specifies
  442.           which directory to use when writing to disk. You can either specify
  443.           an actual drive and directory, or use the DOS convention of
  444.           %variable% , where variable is a DOS environment variable containing
  445.           a valid directory path, such as the MENU variable used in the Menu
  446.           Designer. A batch file named ENVIRON.BAT will be created in the
  447.           directory, which you will use to copy the new environment to the
  448.           original one in the next step.
  449.  
  450.      2.   Run the batch file ENVIRON.BAT once you have exited the new
  451.           environment, and returned to the original one. This will set any
  452.           variables in the original environment that have changed in the
  453.           previous one. You can delete this file after running it if you wish.
  454.  
  455.      The previous environment has now been copied to the original one.
  456.      Following is a sample batch file to demonstrate the process:
  457.     
  458.                                     ┌───  (RUN.BAT)
  459.           COMMAND.COM /C RUN.BAT ───┘ │    SET PRINTER=DOT
  460.           CALL %MENU%ENVIRON.BAT      │    %MENU%ENVIRON.EXE %MENU%
  461.  
  462.  
  463. ** Note - Use the switch /ND switch on the command line of any of the
  464.           environment utilities to disable output display to the screen.
  465.  
  466.  
  467.  
  468. Menu Designer version 1.1                                              Page 10
  469.  
  470.  
  471. USING THE DIRECTORY UTILITIES
  472. (* Registered Version only)
  473.  
  474.      The files DIRGET.EXE and DIRSET.EXE are to be used together to restore a
  475.      directory. The current directory when DIRGET is run will be restored when
  476.      DIRSET is run. Follow the steps below for using the directory utilities:
  477.    
  478.      1.   Run DIRGET.EXE while in the directory you would like to return to.
  479.           The program accepts a command line that specifies which directory to
  480.           use when writing to disk. You can either specify an actual drive and
  481.           directory, or use the DOS convention of %variable% , where variable
  482.           is a DOS environment variable containing a valid directory path, such
  483.           as the MENU variable used in the Menu Designer. A data file named
  484.           CURDIR.DAT will be created in the directory that you specify, or the
  485.           current one if none is specified. You do not need to concern yourself
  486.           with this file. It will be deleted when it is no longer needed.
  487.  
  488.      2.   Run DIRSET.EXE when you would like to return to the preset directory.
  489.           Be sure to specify the same directory or variable on the command line
  490.           as you did for DIRGET, or that you are in the same directory if you
  491.           excluded the directory command line parameter.
  492.  
  493.      The directory is now restored. Once again, remember to include the same
  494.      directory on the command line of both programs, or run them from the same
  495.      directory if not including a path on the command line. Following is a
  496.      sample batch file to demonstrate the process:
  497.  
  498.           %MENU%DIRGET.EXE %MENU%
  499.           %MENU%MENU.EXE %1
  500.           %MENU%DIRSET.EXE %MENU%
  501.  
  502.  
  503. ** Note - Use the switch /ND switch on the command line of either of the
  504.           directory utilities to disable output display to the screen.
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517. Copyright (c) 1993 by Officesoft Innovative Systems,  All rights reserved.
  518.  
  519.